logo
API docs by Redocly

Order Management REST Service (2.45)

Download OpenAPI specification:Download

The Order Management API provides developers a way to view and manage orders.

System Integrity

Resources related to System Integrity.

Health Check

Use to check whether or not the Order Management system is up and running.

Authorizations:
SWT

Responses

Auxiliary Data

Read-only resources that provide additional information related to order management.

List No Sale Reasons

List the No Sale Reasons in the system. [Rev 2.29]

Available Fields

The following is a list of fields from the No Sale Reasons type and how they can be used.

  • Filterable : noSaleType

  • Sortable : description

Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

List Order Transaction Types

List the Order Transaction Types in the system. [Rev 2.04]

Available Fields

The following is a list of fields from the Order Transaction Type type and how they can be used.

  • Filterable : name, orderTransactionTypeID

  • Sortable : name

Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

List Retail Discount Reasons

List the Retail Discount Reasons in the system. [Rev 1.03]

Available Fields

The following is a list of fields from the Retail Discount Reason type and how they can be used.

  • Filterable : endDate, hideOnSales, isForPriceAdjustment [Rev 2.36], retailDiscountReasonID, startDate

  • Sortable : description

Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

List Return Reasons

List the Return Reasons in the system. [Rev 2.23]

Available Fields

The following is a list of fields from the Return Reasons type and how they can be used.

  • Filterable : description, returnReasonID

  • Sortable : description

Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Callbacks

Resources related to Callbacks.

Provisioning Request Callback

Updates the provisioning batch item associated to a given provisioning request. [Rev 1.12]

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
note
string

Note about the provisioning batch.

provider
string

Name of the provider associated to the provisioning batch item.

provisioningRequestID
integer

Unique identifier of the provisioning request.

provisioningRequestStatusID
integer

Unique identifier of the provisioning request status.

Responses

Request samples

Content type
application/json
{
  • "note": "Processing remaining items in provisioning batch.",
  • "provider": "Verizon",
  • "provisioningRequestID": 12,
  • "provisioningRequestStatusID": 2
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Provisioning Request Batch Callback

Updates the IsRunning and Note properties of a given provisioning batch. [Rev 1.12]

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
isRunning
boolean

Whether or not the provisioning batch has any items still being processed.

note
string

Note about the provisioning batch.

provisioningRequestBatchID
integer

Unique identifier of the provisioning batch.

Responses

Request samples

Content type
application/json
{
  • "isRunning": true,
  • "note": "Processing remaining items in provisioning batch.",
  • "provisioningRequestBatchID": 12
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Carts

Resources related to Carts.

Search Carts

Search for Carts. [Rev 2.04]

Available Fields

The following is a list of fields from the Search Cart Response type and how they can be used within the search.

  • Filterable : accountNumber, cartID, createDate, createUser, customerID, customerName, lastModifiedDate, lastModifiedUser, orderID, orderStateID, orderType, orderTypeID, receiptNumber, salesCode, salesCodeID

  • Sortable : accountNumber, cartID, customerName, createDate, lastModifiedDate, lastModifiedUser, orderState, orderType, receiptNumber, salesCode

Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Credit Evaluation

Resources related to Credit Evaluation.

Evaluate Credit Check Required

Evaluate if a credit check is required for a specific customer. [Rev 2.31]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
creditCheckSkipped
required
bool

Indicates if the credit check should be skipped.

isNewService
required
bool

Indicates if the credit check is for a new service.

orderTypeID
required
integer

Unique identifier of the order type associated with the credit check.

Responses

Request samples

Content type
application/json
{
  • "creditCheckSkipped": false,
  • "isNewService": false,
  • "orderTypeID": 3
}

Response samples

Content type
application/json
{
  • "creditCheckRequiredProvider": "TransUnion",
  • "messages": [
    ]
}

Evaluate Credit For Customer

Evaluate a customer's credit. [Rev 2.31]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
creditCheckRequired
required
bool

Indicates if the credit check is required.

creditReportID
integer

Unique identifier of the credit report that was generated for the customer.

orderTypeID
required
integer

Unique identifier of the order type associated with the credit check.

Responses

Request samples

Content type
application/json
{
  • "creditCheckRequired": false,
  • "creditReportID": 2,
  • "orderTypeID": 3
}

Response samples

Content type
application/json
{
  • "creditClassKey": "CreditClassA",
  • "creditLimit": 1000,
  • "deposit": {
    },
  • "messages": [
    ]
}

Evaluate Credit For Order

Evaluate credit using the following information from an order: [Rev 2.32]

  • creditCheckRequired - Indicates if the credit check is required.
  • creditReportID - Unique identifier of the credit report that was generated for the customer.
  • customerID - Unique identifier for the customer on the order.
  • disconnectedServices - Count of disconnected services on the order.
  • estimatedMRC - Estimated monthly recurring charges on the order.
  • newServices - Count of new services on the order.
  • orderTypeID - Unique identifier of the order type.
Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "creditClassKey": "CreditClassA",
  • "creditLimit": 1000,
  • "deposit": {
    },
  • "messages": [
    ]
}

Customers

Resources related to Customers.

Search for Exchangeable Service Equipment

Search for Exchangeable Service Equipment for a specific customer.

Available Fields

The following is a list of fields from the Exchangeable Service Equipment type and how they can be used within the search.

  • Filterable : handsetCatalogID, handsetSKU, handsetSupportedSIMClassID, handsetTechnologyTypeID, serviceCatalogID, serviceID, serviceNumber, serviceTechnologyTypeID, simCardAssociationTypeID, simClassID

  • Sortable : handsetSKU, serviceID, serviceNumber

Authorizations:
SWT
path Parameters
customerID
required
number
Example: 1

Unique identifier for the customer the equipment is associated with.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Search Voidable Transactions

Search for transactions from a specific customer that can be voided. [Rev 2.23]

Note

  • Transactions that contain Move Service actions or deposits that have not been received are not voidable.
  • Transactions that contain negative Paymentus tenders are not voidable.

Available Fields

The following is a list of fields from the Voidable Transaction type and how they can be used within the search.

  • Filterable : receiptNumber, submitDate

  • Sortable : receiptNumber, submitDate

Authorizations:
SWT
path Parameters
customerID
required
number
Example: 1

Unique identifier for the customer the voidable transactions are associated with.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

DirectInvoices

Resources related to Direct Invoices.

Search Direct Invoices

Search for Direct Invoices. [Rev 2.10]

Available Fields

The following is a list of fields from the Search DirectInvoice Response type and how they can be used within the search.

  • Filterable : accountNumber, createDate, createUser, customerID, customerName, directInvoiceID, submitDate, submitUser, lastModifiedDate, lastModifiedUser, orderID, orderStateID, orderTypeID, receiptNumber, salesCode, salesCodeID

  • Sortable : accountNumber, createDate, createUser, customerName, directInvoiceID, submitDate, submitUser, lastModifiedDate, lastModifiedUser, orderState, orderType, receiptNumber, salesCode

Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

No Sales

Resources related to No Sales.

Search No Sales

Provides a Searchable List of No Sale Transactions for the user making the request. [Rev 2.35]

Available Fields

The following is a list of fields from a no sale transaction and how they can be used within the search.

  • Filterable : createDate, createUser, location, locationID, noSaleID, noSaleType, orderState, orderStateID, receiptNumber, register, registerID, registerNumber
  • Sortable : createDate, createUser, location, locationID, noSaleID, noSaleType, orderState, orderStateID, receiptNumber, register, registerID, registerNumber
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Create No Sale

Create a No Sale Transaction with the option of adding No Sale Tenders. [Rev 2.29]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
noSaleReasonID
integer

Unique identifier of the reason that the No Sale transaction was created.

noSaleType
required
string
Enum: "AddCash" "Float" "FloatCorrection" "OpenDrawer" "PettyCash" "Reconcile" "SkimCash"

The type of the No Sale transaction.

note
string

A note or comment to be associated with the No Sale transaction.

overridePolicy
bool

Indicates if this No Sale transaction should have Override Date & User populated by the user making the request.

placeOnHold
bool

Indicates if this No Sale transaction Order Status should be set to OnHold to save for future processing.

Note

  • A value of 'true' is only allowed if the noSaleType is 'Reconcile'.
reconcileDate
string <date-time>

Timestamp when reconcile was launched, before system-provided amounts were fetched.

Note

  • If this value is present, will be used as CreateDate.
registerID
required
integer

Unique identifier of the register that the No Sale transaction is to be associated with.

Array of objects (CreateNoSaleTenders)

Responses

Request samples

Content type
application/json
{
  • "noSaleReasonID": 4,
  • "noSaleType": "Reconcile",
  • "note": "Starting a New Drawer",
  • "overridePolicy": true,
  • "placeOnHold": true,
  • "reconcileDate": "2024-2-27T18:03:36.443-04:00",
  • "registerID": 43,
  • "tenders": [
    ]
}

Response samples

Content type
application/json
{
  • "createDate": "2024-03-15T15:37:47.9923216-04:00.",
  • "errorMessage": "Unexpected error during processing of NoSaleTxnID 1039.",
  • "noSaleTxnID": 33,
  • "orderState": "Errored",
  • "receiptNumber": "STORE-05-0647"
}

Delete No Sale

Delete a No Sale transaction. [Rev 2.30]

Notes

  • No Sale transactions must currently be in an OnHold or Errored state and must be of noSaleType Reconcile.
Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get No Sale

Get the details of a No Sale transaction. [Rev 2.30]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "createDate": "2024-03-15T15:37:47.9923216-04:00.",
  • "createUser": "nice_user",
  • "location": "Store #4",
  • "locationID": 4,
  • "message": "Unexpected error during processing of NoSaleTxnID 1039.",
  • "orderState": "Errored",
  • "orderStateID": 5,
  • "noSaleReason": "Start of a Shift",
  • "noSaleReasonID": 2,
  • "noSaleType": "Float",
  • "note": "Changing cashiers",
  • "overrideDate": "2024-03-15T17:37:47.9923216-04:00.",
  • "overrideUser": "manager_example",
  • "receiptNumber": "STORE3-05-0590",
  • "register": "Register_4",
  • "registerID": 9,
  • "registerNumber": 14,
  • "tenders": [
    ]
}

Resume No Sale

Attempt to complete a No Sale transaction. [Rev 2.30]

Notes

  • No Sale transactions must currently be in an OnHold or Errored state and must be of noSaleType Reconcile.
Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
overridePolicy
bool

Indicates if this No Sale transaction should have Override Date & User populated by the user making the request.

Responses

Request samples

Content type
application/json
{
  • "overridePolicy": false
}

Response samples

Content type
application/json
{
  • "errorMessage": "Unexpected error during processing of NoSaleTxnID 1039.",
  • "orderState": "Errored"
}

Orders

Resources related to Orders.

Create Order

Create an Order with the option of using a Starting Block. [Rev 2.04]

Note

  • A Starting Block can be used to create different types of transactions and initialize certain fields.
Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
creditCheckRequiredProviderID
integer

The ID of the provider that will be used to perform the credit check. [Rev 2.31]

creditReportID
integer

The ID of the credit report that was generated for the order. [Rev 2.31]

customerID
integer

Unique identifier of the customer that the order is to be associated with.

description
string

A description for the order.

estimatedCompleteDate
string <date>

The date that the order is estimated to be completed.

newAccountStatusID
integer

Unique identifier of a new valid account status to be set on the account by this order.

Note

  • When specifying this field, CustomerID is also required in order to identify the account.
note
string

A note or comments to be associated with the order.

orderTypeID
integer

Unique identifier of a configured Order Type to be associated with the order, which may drive order processing.

Note

  • This value is ignored when a starting block containing a value for 'orderTypeID' is specified.
registerID
integer

Unique identifier of a configured Regiser to be associated with the order, which may drive order processing.[Rev 2.10]

Note

  • This value is ignored when a starting block containing a value for 'registerID' is specified.
salesCodeID
integer

Unique identifier of a configured Sales Code for a sales associate or sales entity to be associated with the order.

sourceCodeID
integer

Unique identifier of a configured Source Code to be associated with the order.

startingActionID
integer

Unique identifier for the starting action associated with this order.

Note

  • This value is ignored when a starting block is specified.
startingBlockID
integer

Unique identifier of the configured Starting Block to be used when creating this order.

Note

A Starting Block can be used to not only initialize certain fields, but also create orders for different types of transactions based upon the following StartAsOption values configured within the starting block:

1 Order

2 Sale

3 Direct Invoice [Rev 2.10]

Responses

Request samples

Content type
application/json
{
  • "creditCheckRequiredProviderID": 2,
  • "creditReportID": 24,
  • "customerID": 1014,
  • "description": "For a damaged, lost, or stolen device that is still under warranty.",
  • "estimatedCompleteDate": "2020-04-21",
  • "newAccountStatusID": 1014,
  • "note": "Replacing Device",
  • "orderTypeID": 1014,
  • "registerID": 1014,
  • "salesCodeID": 42,
  • "sourceCodeID": 43,
  • "startingActionID": 2,
  • "startingBlockID": 44
}

Response samples

Content type
application/json
{
  • "cartID": 1234,
  • "directInvoiceID": 0,
  • "orderID": 4321
}

Search Orders

Provides a searchable list of orders. [Rev 2.04]

Available Fields

The following is a list of fields from an order and how they can be used within the search.

  • Filterable : accountNumber, checkoutDate, createUser, customerID, customerName, holdDate, holdReasonID, lastModifiedDate, lastModifiedUser, orderID, orderStateID, orderTransactionTypeID, orderTypeID, processingDate, processingStartedDate, processingStoppedDate, receiptNumber, salesCodeID, sourceCodeID, startingActionID, startingBlockID, submitDate
  • Sortable : accountNumber, createDate, createUser, customerName, holdDate, holdReason, lastModifiedDate, lastModifiedUser, orderID, orderState, orderTransactionType, orderType, processingDate, processingStartedDate, processingStoppedDate, receiptNumber, salesCode, sourceCode, startingAction, startingBlock, submitDate
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Get an Order

Retrieve a specific Order by ID. [Rev 2.04]

Authorizations:
SWT
path Parameters
orderID
required
integer

Unique ID of the Order to retrieve.

Responses

Response samples

Content type
application/json
{
  • "accountNumber": "ABCAccountNum",
  • "checkoutDate": "2020-10-27T16:03:36.443-04:00",
  • "createDate": "2020-10-27T16:03:36.443-04:00",
  • "createUser": "myusername",
  • "customerID": 1,
  • "customerName": "John Smith",
  • "description": "My Order Description",
  • "estimatedCompleteDate": "2020-10-27T16:03:36.443-04:00",
  • "holdDate": "2020-10-27T16:03:36.443-04:00",
  • "holdReason": "Call Customer to Confirm",
  • "holdReasonID": 1,
  • "initiatingCallID": "my service representative id",
  • "lastModifiedDate": "2020-10-27T16:03:36.443-04:00",
  • "lastModifiedUser": "TRogers",
  • "newAccountStatus": "Suspended",
  • "newAccountStatusID": 1014,
  • "note": "TRogers",
  • "orderID": 1,
  • "orderState": "Submitted",
  • "orderStateID": 1,
  • "orderTransactionType": "Order",
  • "orderTransactionTypeID": 3,
  • "orderType": "Add Service Order Type Name",
  • "orderTypeID": 1,
  • "processingDate": "2020-10-27T16:03:36.443-04:00",
  • "processingStartedDate": "2020-10-27T16:03:36.443-04:00",
  • "processingStoppedDate": "2020-10-27T16:03:36.443-04:00",
  • "receiptNumber": "ABC12345",
  • "salesCode": "AA99",
  • "salesCodeID": 1,
  • "sourceCode": "my source code name",
  • "sourceCodeID": 1,
  • "startingAction": "my starting action name",
  • "startingActionID": 1,
  • "startingBlock": "My Fave!",
  • "startingBlockID": 44,
  • "submitDate": "2020-10-27T16:03:36.443-04:00",
  • "tenderTotal": 25,
  • "workflowRequestGUID": "11111111-2222-3333-4444-555555555555"
}

Search Order Details

Search for details of all order items. [Rev 2.07]

Notes

  • To obtain all auxiliary items in proper sequence after their primary items, sort by orderDetailID, then isAuxiliary.
  • To obtain all package children in proper sequence after their parent items, sort by parentOrderDetailID, orderDetailID, then isAuxiliary.

Available Fields

The following indicates how each field can be used.

  • Filterable : inventoryStatusID, objectType, orderDetailID, parentOrderDetailID, serviceInformationItemID, serviceNumber, sku
  • Sortable : inventoryStatus, isAuxiliary, ledgerItemID, orderDetailID, parentOrderDetailID, priceAdjustmentID, serviceInformationItemID [Rev 2.08]
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order that the items are associated with.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Order Item Summary

Returns the items within an order. [Rev 1.14]

Available Fields

The following indicates how each field can be used.

  • Filterable : orderActionID, orderItemID, serviceInformationItemID, sku, quantity
  • Sortable : orderActionID, orderItemID, serviceInformationItemID, sku, quantity
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1256

Unique identifier of the order.

Request Body schema: application/json
catalogGroupIDs
Array of integers

If supplied, the action will only be performed against services with a catalog group id in this list.

serviceCatalogIDs
Array of integers

If supplied, the action will only be performed against services with a service catalog id in this list.

serviceInformationItemIDs
Array of integers

If supplied, the action will only be performed against services associated with a service information item id in this list.

serviceProcessingActionIDs
Array of integers

If supplied, the action will only be performed against services associated to service information item with a processing action id in this list.

Responses

Request samples

Content type
application/json
{
  • "catalogGroupIDs": [
    ],
  • "serviceCatalogIDs": [
    ],
  • "serviceInformationItemIDs": [
    ],
  • "serviceProcessingActionIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Customer Action

Information about an order/cart that performs an action on their customer account.

Authorizations:
SWT
path Parameters
orderID
required
number
Example: 1

Unique identifier of the order.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34636,
  • "ActionType": "order/cart action",
  • "ActionTypeID": 83468,
  • "ChangeDescription": "action description",
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "ExcludeFinalBilledOneTimeCharges": true,
  • "ExpireUnitsOnDisconnect": true,
  • "ExtendedInformation": { },
  • "ExtendedInformationID": 0,
  • "IncludeFutureDisconnectedChildren": false,
  • "IsPortingOut": true,
  • "NewAccountStatus": "new account status description",
  • "NewAccountStatusID": 83468,
  • "OrderDescription": "order/cart description",
  • "OrderID": 83468,
  • "Reason": "configured change reason description",
  • "ReasonID": 354883,
  • "ReconnectFinalBilledItems": true,
  • "ReconnectMethodPrimary": "my reconnect method primary",
  • "ReconnectMethodPrimaryID": 0,
  • "ReconnectMethodSecondary": "my reconnect method secondary",
  • "ReconnectMethodSecondaryID": 0,
  • "RestartFinalBilledBillingCharges": true,
  • "SuspendDate": "2017-09-09T17:35:09.156Z"
}

Capture Tender

Marks a TenderInformationItem within an order as having been Captured by means of the other information supplied in the request. [Rev 1.07]

Notes

  • Only TenderInformationItems of base tender type BTA are currently allowed to be captured
  • Order must have been Submitted
  • TenderInformationItem cannot be locked, i.e. IsReadOnly = True [Rev 1.11], and status must be Open or Authorized
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1256

Unique identifier of the order that contains the TenderInformationItem to be captured.

tenderInformationItemID
required
integer
Example: 97

Unique identifier of a TenderInformationItem to be captured within the specified order.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
adjustmentID
integer

Unique identifier of the corresponding adjustment that was made on the customer account for this tender

Note

  • Field is required for capture of TenderInformationItems of base tender type BTA.

  • The adjustment must be associated to the same customer account as the specified order.

  • The adjustment amount must be the same as the TenderInformationItem amount.

  • The adjustment's type must be the same as the one configured for either the debit or credit adjustment type for the tender type of the TenderInformationItem, based on whether the adjustment amount is positive (debit) or negative (credit).

Responses

Request samples

Content type
application/json
{
  • "adjustmentID": 7654321
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List Checkout Overview

Lists the subtotal, total, tax and tender amounts currently associated with the order [Rev 1.01]

Notes

  • Subtotal information will only be valid once a checkout has been performed.

Available Fields

The following is a list of fields from the Exchangeable Service Equipment type and how they can be used within the search.

  • Filterable : categoryID,
  • Sortable : amount, categoryPosition
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order to list the checkout amounts for.

query Parameters
compactSubtotalMode
boolean
Example: compactSubtotalMode=true

Indicates whether or not the subtotal section should be broken into separate sections per overviewID. [Rev 2.08]

compactTaxMode
boolean
Example: compactTaxMode=false

Indicates whether or not the tax section should be broken into separate sections per tax ID. [Rev 2.08]

itemActionMode
any

Indicates whether or not the subtotal section should be broken into separate sections per order item action Sale vs. Return. [Rev 2.23]

Note

  • This mode is always recommended and will automatically include what Quantity Divisor mode does
quantityDivisorMode
boolean
Example: quantityDivisorMode=false

Indicates whether or not the subtotal section should be broken into separate sections per Quantity Divisor. [Rev 2.18]

Note

  • This mode is recommended when Quantity Divisors are configured on retail products in the product catalog.

  • Multiple subtotal sections will be returned grouping items by the different values in the itemCountDivisor field when this is used, regardless of the compactSubtotalMode option used.

$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

List Items With Agreements

Lists items with agreements that are associated with the order [Rev 2.25]

Available Fields

The following is a list of fields from the OrderItemsWithAgreementsSearchResultItem type and how they can be used within the search.

  • Filterable : contractServiceAgreementID [Rev 2.26], documentTemplateTypeID [Rev 2.26], installmentAgreementGUID [Rev 2.26], installmentAgreementID [Rev 2.26], serviceCatalogID, serviceNumber
  • Sortable : description, installmentAgreementID, serviceAgreementID, serviceCatalog, serviceNumber
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order to list the checkout amounts for.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Generate Receipt

Generate a receipt for an order as a PDF and store it in Document Storage. [Rev 1.06]

Notes

  • An Invoice Template must be configured for the store from which an order is placed.
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order for which to generate a receipt.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
guid
string

The GUID for a receipt in Document Storage. If supplied and a document is found, then the document will be overwritten. Otherwise, a new receipt will be generated and stored.

category
string

The category to which this document should be associated. [Rev 2.15]

  • Default Value : Direct Invoice

Responses

Request samples

Content type
application/json
{
  • "guid": "874c41dc-d104-480f-a576-dac472c5e0e4",
  • "category": "Web Receipt"
}

Response samples

Content type
application/json
{
  • "guid": "874c41dc-d104-480f-a576-dac472c5e0e4"
}

Pause an Order

Will attempt to change the state of an order to Paused so that certain modifications to the order will be allowed.

Notes

  • Order must currently be in a state of Submitted or InProcess
  • Not allowed once billing order processing has begun

Warning

The workflow instance for the order is not changed via this endpoint, but should be requested and ensured to be On Hold before pausing the order.

Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order to be paused.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Renew Advance Pay Service

Renews all active advance pay products on a service in an order with their corresponding favorite price point(s). [Rev 1.02]

Notes

  • Service must not already be in the order.
  • Service must have at least one active advance pay product.
  • Advance Pay product must have a favorite indicated.
  • Advance Pay product must have a valid active charge.
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1256

Unique identifier of the order to place the renew items onto.

serviceID
required
integer
Example: 97

Unique identifier of the service to renew.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "parentServiceInformationItemID": 10,
  • "renewedAdvancePayProductCount": 2,
  • "serviceInformationItemID": 11
}

Resume an Order

Will attempt to change the state of an order from Paused to InProcess.

Notes

  • Order must currently be in a Paused state and must have had a Checkout operation performed after any modifications. Register policy and other validation, similar to submitting an order, will be performed.

Warning

The workflow instance for the order is not changed via this endpoint, but should be requested to become In Progress after resuming the order.

Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order to be resumed.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Search Order Tenders

Will return a list of order tenders for a given order. [1.16]

Available Fields

The following indicates how each field can be used.

  • Filterable : bankAccountTypeID, createDate, creditCardTypeID, expirationDate, isInternalUseOnly, tenderStatusID, tenderTypeID
  • Sortable : amount, createDate, creditCardType, expirationDate, tenderStatus, tenderType
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order used to search for tenders.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Search Retail Items

Search for all retail items associated with the order [Rev 1.15]

Notes

  • To obtain all auxiliary items in proper sequence after their primary items, sort by orderItemID, then isAuxiliary.

Available Fields

The following indicates how each field can be used.

  • Filterable : inventoryStatusID, objectType, orderItemID, serviceInformationItemID, serviceNumber, sku
  • Sortable : inventoryStatus, isAuxiliary, ledgerItemID, orderItemID, priceAdjustmentID
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order that the retail items are associated with.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Search Service Item Summaries

Search Service item summaries for an associated order [Rev 2.07]

Available Fields

The following indicates how each field can be used.

  • Filterable : estimatedMRC, estimatedNRC, processingAction, processingActionID, serviceID, serviceInformationItemID, serviceNumber, serviceType, serviceTypeID, totalRetailCharge
  • Sortable : estimatedMRC, estimatedNRC, processingAction, processingActionID, serviceID, serviceInformationItemID, serviceNumber, serviceType, serviceTypeID, totalRetailCharge
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order that the service item summaries are associated with.

Responses

Response samples

Content type
application/json
{
  • "estimatedMRC": 12.95,
  • "estimatedNRC": 5.95,
  • "processingAction": "Add",
  • "processingActionID": 4,
  • "serviceID": 24,
  • "serviceInformationItemID": 11,
  • "serviceNumber": "8881110000",
  • "serviceType": "Wireless Service",
  • "serviceTypeID": 998003,
  • "totalRetailCharge": 10.25
}

Order Items

Resources related to order items.

Add Price Point

Add a Price Point to an Order Item. [Rev 2.41]

Authorizations:
SWT
path Parameters
orderItemID
required
integer
Example: 1

Unique identifier of the price point's parent order item.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
advancePayPricePointChargeID
required
integer

Unique identifier of the AdvancePay Price Point Charge to add.

quantity
required
integer

The quantity of the order item.

Responses

Request samples

Content type
application/json
{
  • "advancePayPricePointChargeID": 1,
  • "quantity": 1
}

Response samples

Content type
application/json
{
  • "orderItemID": 5
}

Protection Plan Information

Returns Protection Plan Information for an Order Item [Rev 2.03]

Authorizations:
SWT
path Parameters
orderItemID
required
integer
Example: 1

Unique identifier of the order item associated to the protection plan.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "activationDate": "2019-08-24T14:15:22Z",
  • "address1": "123 Main Street",
  • "address2": "Apartment 10",
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "city": "New York",
  • "companyName": "IDI",
  • "country": "USA",
  • "county": "Orange",
  • "email": "jdoe@company.com",
  • "extendedInformation": { },
  • "firstName": "John",
  • "lastName": "Doe",
  • "orderItemID": 1,
  • "protectionPlanID": 1,
  • "protectionPlanInformationID": 1,
  • "protectionPlanProfileID": 1,
  • "serialNumber": "123",
  • "state": "NY",
  • "zip": "55555",
  • "verificationRequestID": 0
}

Search Retail Discounts

Search the Retail Discounts associated with an order item. [Rev 1.04]

Available Fields

The following indicates how each field can be used.

  • Filterable : promotionID, retailDiscountID, retailDiscountType
  • Sortable : description, retailDiscountType
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Update Order Item

Update fields for an Order Item [Rev 2.27]

Note

  • This operation uses the JSON Patch document structure for specifying updates to Order Items, which you can read more about here: JSON Patch (RFC 6902).

Patchable Fields

Allowed patch operations for each patchable property of an Order Item.

  • quantityFulfilled : add, remove, replace
    • Valid Values This value must be greater than or equal to 0 and less than or equal to quantity.
Authorizations:
SWT
path Parameters
orderItemID
required
integer
Example: 1

Unique identifier of the order item to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Order Provisioning

Resources related to Order Provisioning.

Create Provisioning Batch

Will attempt to create a set of items that need to be provisioned for the given order. [1.10]

Notes

  • If the workItemInstanceID is specified then a new batch will only be created if there is no other open batch associated to that workiteminstanceID
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order to use to generate the batch.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
afterBSU
boolean

Indicates whether the provisioning batch item's provisioning request is being performed after BSU (Billing System Update) has completed. [Rev 2.36]

object (OrderLineItemFilter)

[Rev 1.12]

workItemInstanceID
integer

Unique identifier for the workflow item that created this batch if the batch generation originated from workflow.

Responses

Request samples

Content type
application/json
{
  • "afterBSU": true,
  • "orderLineItemFilter": {
    },
  • "workItemInstanceID": 1004
}

Response samples

Content type
application/json
{
  • "isOpen": true,
  • "itemCount": 0,
  • "lastModified": "2008-10-27T16:03:36.443-04:00",
  • "provisioningBatchID": 3,
  • "workItemInstanceID": 1004
}

Search Provisioning Batch Items

Will return a list of provisionable items within a batch for a given order. This list can be used to find the items that still need to be sent to provisioning by filtering isComplete [1.10]

Available Fields

The following indicates how each field can be used.

  • Filterable : code, isComplete, orderTxnItemID, provider [Rev 1.12], provisioningBatchItemID, provisioningRequestStatusID [Rev 1.12], regenerated [Rev 1.16], serviceInformationItemID
  • Sortable : code, isComplete, lastModifiedDate, orderTxnItemID, provider [Rev 1.12], provisioningBatchItemID, provisioningRequestStatus [Rev 1.12], serviceInformationItemID
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order to use to generate the batch.

provisioningBatchID
required
integer
Example: 2

Unique identifier of the provisioning batch to iterate through.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Provision Batch Item

Will attempt to provision the indicated batch item. If the batch item is successfully submitted for provisioning the item will be marked as complete. If the batch item is the last incomplete item in its batch then the batch will be closed automatically. [1.10]

If regenerate is true and the batch item status is 'In Error', then the provisioning request will be regenerated for this batch item. [Rev 1.16]

Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order to use to generate the batch.

provisioningBatchID
required
integer
Example: 1

Unique identifier of the provisioning batch the batch item belongs to

provisioningBatchItemID
required
integer
Example: 1

Unique identifier of the provisioning batch item to send to create a provisioning request for.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
profileID
required
integer

Indicates the profile to use when generating the provisioning request.

regenerate
boolean

Indicates if the provisioning batch item's provisioning request should be regenerated. [Rev 1.16]

Responses

Request samples

Content type
application/json
{
  • "profileID": 11,
  • "regenerate": false
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Validate Provisioning Batch Item Transition

Will validate the provisioning batch item's transition against the one provided in this call. If they do not match and deleteInvalidBatchItem is true, then the corresponding provisioning batch item is deleted. Either way, the validation result is returned with the batch item's Provisionable Object Code and Provisionable Object Transition. [Rev 2.37]

Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order to use to generate the batch.

provisioningBatchID
required
integer
Example: 1

Unique identifier of the provisioning batch the batch item belongs to.

provisioningBatchItemID
required
integer
Example: 1

Unique identifier of the provisioning batch item to send to create a provisioning request for.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
deleteInvalidBatchItem
boolean

Indicates if the provisioning batch item should be deleted if not valid.

transition
required
string
Enum: "Activate" "Deactivate" "Reactivate" "Restore" "Suspend"

The transition to validate the batch item against.

Responses

Request samples

Content type
application/json
{
  • "deleteInvalidBatchItem": false,
  • "transition": "Activate"
}

Response samples

Content type
application/json
{
  • "isValid": true,
  • "provisionableObjectCode": 12345,
  • "provisionableObjectTransition": "Activate"
}

List Provisioning Links For An Order

Lists the provisionable object codes associated with the items requested. [Rev 2.10]

Available Fields

The following is a list of fields from the Exchangeable Service Equipment type and how they can be used within the search.

  • Filterable : catalogID, internalID, serviceID, serviceInformationItemID
  • Sortable : catalogID, internalID, serviceID, serviceInformationItemID
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order to list the provisionable object codes for.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Provisioning Request Summary

Returns a summary of the provisioning batch items for a given order. [Rev 1.13]

Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order associated to the provisioning batch items.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cancelledItemsCount": 1,
  • "completedItemsCount": 1,
  • "createdItemsCount": 2,
  • "pendingItemsCount": 1,
  • "inErrorItemsCount": 1,
  • "inProgressItemsCount": 1,
  • "lastActivityDate": "04/21/2020 04:23:43 AM",
  • "submittedItemsCount": 2
}

Search Provisioning Information Items

Provides a searchable list of provisioning data associated with an order. [Rev 1.16]

Available Fields

The following is a list of fields from the Exchangeable Service Equipment type and how they can be used within the search.

  • Filterable : code, keyName, serviceInformationItemID
  • Sortable : code, keyName, serviceInformationItemID
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order used to search for tenders.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "code": "DSL",
  • "keyName": "Shelf",
  • "provisioningInformationItemID": 10,
  • "serviceInformationItemID": 1,
  • "value": "2"
}

Setup Provisioning Information Items

Will setup the Provisioning Information Items in the Order for products and services that are linked to POD Properties.

Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order to be paused.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
serviceInformationItemID
integer

Unique identifier for the service information item this data will be associated with.

Note

  • When a serviceInformationItemID is specified the POD properties for that service and products under that service will be setup.

Responses

Request samples

Content type
application/json
{
  • "serviceInformationItemID": 1
}

Response samples

Content type
application/json
{
  • "associatedProvisioningInformationItems": 10
}

Provisioning Information Item Order Details

Provides a searchable list of provisioning data associated with an order. [Rev 2.10]

Available Fields

The following is a list of fields from the Provisioning Information Item Order Detail type and how they can be used within the search.

  • Filterable : code, internalID, isLocked, keyName, featureAction, serviceAction, serviceGroup, serviceInformationItemID, serviceType, serviceTypeID
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Provisioning Information Item Order Summary

Provides a summary of provisioning information items associated with an order. The items are grouped by code, service action, service group, and service type. [Rev 2.10]

The following will show the up to the first 100 unique items: codes, service groups and service types. [Rev 2.13]

Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order.

Responses

Response samples

Content type
application/json
{
  • "totalAccountLevelLockedProperties": 5,
  • "totalAccountLevelUnlockedProperties": 2,
  • "totalProperties": 5,
  • "totalLockedProperties": 2,
  • "totalCodes": 5,
  • "codes": [
    ],
  • "serviceActions": [
    ],
  • "totalServiceGroups": 5,
  • "serviceGroups": [
    ],
  • "totalServiceTypes": 5,
  • "serviceTypes": [
    ]
}

Provisioning Information Item Order Summary Codes

Provides a summary of the codes for the provisioning information items associated with an order. [Rev 2.11]

Available Fields

The following is a list of filterable fields.

  • Filterable : accountLevelLockedCount, accountLevelUnlockedCount, lockedCount, name, and unlockedCount
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Provisioning Information Item Order Summary Service Action

Provides a summary of the service actions for the provisioning information items associated with an order. [Rev 2.12]

Available Fields

The following is a list of filterable fields.

  • Filterable : lockedCount, name, and unlockedCount
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Provisioning Information Item Order Summary Service Types

Provides a summary of the service types for the provisioning information items associated with an order. [Rev 2.11]

Available Fields

The following is a list of filterable fields.

  • Filterable : lockedCount, name, and unlockedCount
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Provisioning Information Item Order Summary Service Group

Provides a summary of the service groups for the provisioning information items associated with an order. [Rev 2.11]

Available Fields

The following is a list of filterable fields.

  • Filterable : lockedCount, name, and unlockedCount
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Commit Staged Provisioning Information Items

Will set the property value of Provisioning Information Items equal to the Staged value for that property and delete all the staged records for that order.

Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order to be paused.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "stagedItemsCommitted": 10
}

Staged Provisioning Information Items

Delete staged provisioning information items. [Rev 2.10]

Note: The request body filters which staged provisioning information items will be deleted. A filter is not required, but a combination of code and/or keyName will work.

Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order that the staged provisioning information items are associated with.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
code
string

Indicates which staged provisioning information items to delete by associated provisioning information item code. When not supplied, the filter will not include a specific code.

keyName
string

Indicates which staged provisioning information items to delete by associated provisioning information item keyName. When not supplied, the filter will not include a specific keyName.

Responses

Request samples

Content type
application/json
{
  • "code": "code",
  • "keyName": "keyName"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Staged Provisioning Information Items

Provides a searchable list of staged provisioning data associated with an order. [Rev 2.10]

Available Fields

The following is a list of fields from the Exchangeable Service Equipment type and how they can be used within the search.

  • Filterable : code, featureAction, internalID, keyName, sericeAction, serviceTypeID, serviceInformationItemID
Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Staged Provisioning Information Items

Add or replace staged provisioning information items. [Rev 2.10]

Authorizations:
SWT
path Parameters
orderID
required
integer
Example: 1

Unique identifier of the order that the staged provisioning information items are associated with.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
provisioningInformationItemID
required
integer

Unique identifier of the provisioning information item to stage a value for.

value
string

Value to be staged as the new provisioning information item value. Value will default to null if not provided.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "itemsUpdated": 1
}

Paymentus

Resources related to Paymentus.

Create Paymentus Refund

Creates a negative tender by refunding a Paymentus transaction. [Rev 2.35]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
amount
required
number

Amount to be refunded.

Note

  • The amount must be negative.
orderID
required
integer

Unique identifier of an order.

Note

  • The order must have a register with valid Paymentus payment gateway settings.
referenceNumber
required
string

Unique identifier of a transaction in the Paymentus system.

Responses

Request samples

Content type
application/json
{
  • "amount": -10,
  • "orderID": 1,
  • "referenceNumber": "123456789"
}

Response samples

Content type
application/json
{
  • "errorMessage": "Error during processing of refund for ReferenceNumber 102936961: Unable to reverse transaction.",
  • "paymentusTransactionID": 5,
  • "paymentusTransactionOrderLinkID": 1,
  • "tenderInformationItemID": 3
}

Create Paymentus Tender

Creates a positive tender for a Paymentus transaction. [Rev 2.33]

Note

  • One of orderID or referenceNumber must be specified in the request, but not both.
Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
orderID
integer

Unique identifier of an order.

Note

  • A Paymentus Transaction Order Link with a matching OrderID must exist, with no associated Paymentus Transaction or Tender Information Item.
paymentusTransactionID
required
integer

Unique identifier of a Paymentus transaction in the CostGuard system.

Note

  • The Paymentus Transaction Amount must be positive.
  • If orderID is provided, it must match the Paymentus Transaction CGReferenceNumber.
  • If referenceNumber is provided, it must match the Paymentus Transaction ReferenceNumber.
referenceNumber
string

Unique identifier of a transaction in the Paymentus system.

Note

  • A Paymentus Transaction Order Link with a matching ReferenceNumber must exist, with no associated Paymentus Transaction or Tender Information Item.

Responses

Request samples

Content type
application/json
{
  • "orderID": 1,
  • "paymentusTransactionID": 5,
  • "referenceNumber": "123456789"
}

Response samples

Content type
application/json
{
  • "paymentusTransactionOrderLinkID": 1,
  • "tenderInformationItemID": 3
}

Delete Paymentus Tender

Delete a positive Paymentus tender from an order. [Rev 2.34]

Note

  • A Paymentus Transaction Order Link with a matching TenderInformationItemID must exist.
  • Tenders that are in a Completed or Cancelled order are read-only and cannot be deleted.
Authorizations:
SWT
path Parameters
tenderInformationItemID
required
number
Example: 13

Unique identifier of a Tender Information Item to be deleted.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Provisioning Requests

Resources related to Provisioning Requests.

Search Provisioning Requests

Will return a list of provisioning requests with associated information. [Rev 1.13]

Available Fields

The following indicates how each field can be used.

  • Filterable : AccountNumber, Code, CustomerID, CustomerName, IsComplete, Note, LastModifiedDate, OrderItemCatalog, OrderItemCatalogID, OrderItemCatalogSKU, OrderItemID, OrderTxnID, OrderTypeID, Provider, ProvisioningRequestID, ProvisioningRequestStatusID, Regenerated [Rev 1.16], ServiceInformationItemCatalog, ServiceInformationItemCatalogID, ServiceInformationItemCatalogSKU, ServiceInformationItemID, ServiceNumber
  • Sortable : Code, LastModifiedDate, Note, OrderItem, OrderItemCatalog, OrderItemCatalogSKU, Provider, ProvisioningRequestStatus, Regenerated [Rev 1.16], ServiceInformationItem, ServiceInformationItemCatalog, ServiceInformationItemCatalogSKU, ServiceNumber
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Regenerate Provisioning Request

Regenerate a provisioning request if the status is In Error. [Rev 1.16]

Authorizations:
SWT
path Parameters
required
integer
Example: 13

Unique identifier of the provisioning request to regenerate.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Sales

Resources related to Sales.

Search Sales

Search for Sales. [Rev 2.05]

Available Fields

The following is a list of fields from the Search Sale Response type and how they can be used within the search.

  • Filterable : accountNumber, createDate, createUser, customerID, customerName, finalizedDate, finalizedUser, lastModifiedDate, lastModifiedUser, orderID, orderStateID, orderType, orderTypeID, receiptNumber, saleID, salesCode, salesCodeID

  • Sortable : accountNumber, customerName, createDate, finalizedDate, finalizedUser, lastModifiedDate, lastModifiedUser, orderState, orderType, receiptNumber, saleID, salesCode

Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Service Information Item Service Addresses

Resources related to service information item service addresses.

Search Service Information Item Service Addresses

Returns service addresses linked to Service Information Items. [Rev 2.45]

Available Fields

The following is a list of fields and how they can be used within the search.

  • Filterable : city, location, msagCommunity, msagCountyID, msagError, msagProviderID, rateCenterID, serviceAddressID, serviceAddressStatusID, serviceInformationItemID, state, streetName, taxAddressError, wireCenterID, zipCode
  • Sortable : city, location, msagCommunity, msagCountyID, msagProvider, msagValidated, rateCenter, serviceAddressID, serviceAddressStatus, serviceInformationItemID, state, streetName, wireCenter, zipCode
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Service Information Items

Resources related to service information items.

Get E911 Service Address Information

Returns E911 Service Address Information for a Service Information Item. [Rev 2.24]

Authorizations:
SWT
path Parameters
serviceInformationItemID
required
integer
Example: 1

Unique identifier of the service information item the service address information is associated to.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "e911ClassOfService": "Business",
  • "e911ClassOfServiceID": 2,
  • "e911ServiceAddressID": 123,
  • "e911TypeOfService": "Non-Pub",
  • "e911TypeOfServiceID": 3
}

Update E911 Service Address Information

Update E911 Service Address Information for a Service Information Item. [Rev 2.24]

Note

  • This operation uses the JSON Patch document structure for specifying updates to Service Address Information, which you can read more about here: JSON Patch (RFC 6902).

Patchable Fields

Allowed patch operations for each patchable property of Service Address Information for a Service Information Item.

  • e911ClassOfServiceID : add, remove, replace

  • e911ServiceAddressID : add, remove, replace

    • Valid Values This value must exist in the list of Service Addresses for this Service Information Item.

  • e911TypeOfServiceID : add, remove, replace

Authorizations:
SWT
path Parameters
serviceInformationItemID
required
integer

Unique ID of the Service Information Item to update Service Address Information for.

Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Starting Blocks

Resources related to Starting Blocks.

Allowed Starting Blocks

Returns active Starting Blocks given a user's permissions with optional Start Location, Customer ID, or Service ID filters. [Rev 2.06]

Available Fields

The following is a list of fields from the Allowed Starting Blocks Response type and how they can be used within the search.

  • Filterable : caption, name, orderTypeID, startAsOptionID, startingActionID, startingBlockID

  • Sortable : caption, name, orderType, startAsOption, startingAction

Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Request Body schema: application/json
allowsAddFeature
boolean

Allow Starting Blocks that support the "Add Feature" action.

allowsAddOrder
boolean

Allow Starting Blocks that support the "Add Order" action.

allowsAddService
boolean

Allow Starting Blocks that support the "Add Service" action.

allowsBillPayment
boolean

Allow Starting Blocks that support the "Bill Payment" action. [Rev 2.21]

allowsDisconnectCustomer
boolean

Allow Starting Blocks that support the "Disconnect Customer" action.

allowsDisconnectService
boolean

Allow Starting Blocks that support the "Disconnect Service" action.

allowsHotlineService
boolean

Allow Starting Blocks that support the "Hotline Service" action.

allowsReconnectCustomer
boolean

Allow Starting Blocks that support the "Reconnect Customer" action.

allowsReconnectService
boolean

Allow Starting Blocks that support the "Reconnect Service" action.

allowsRedirectService
boolean

Allow Starting Blocks that support the "Redirect Service" action.

allowsRefreshService
boolean

Allow Starting Blocks that support the "Refresh Service" action. [Rev 2.18]

allowsRestoreService
boolean

Allow Starting Blocks that support the "Restore Service" action.

allowsReturnItem
boolean

Allow Starting Blocks that support the "Return Item" action [Rev 2.22].

allowsSuspendService
boolean

Allow Starting Blocks that support the "Suspend Service" action.

allowsSwapEquipment
boolean

Allow Starting Blocks that support the "Swap Equipment" action.

allowsVoidTransaction
boolean

Allow Starting Blocks that support the "Void Transaction" action. [Rev 2.23]

customerID
integer

Unique identifier of the customer of which the supported Starting Actions are derived.

serviceID
integer

Unique identifier of the service of which the supported Starting Actions are derived.

startLocation
string
Enum: "AccountLevel" "Order" "ServiceLevel"
  • 'AccountLevel' - Used when initiating a Starting Block from a customer's account.
  • 'Order' - Used when initiating a Starting Block from Orders.
  • 'ServiceLevel' - Used when initiating a Starting Block from a customer's service.

Responses

Request samples

Content type
application/json
{
  • "allowsAddFeature": true,
  • "allowsAddOrder": true,
  • "allowsAddService": true,
  • "allowsBillPayment": true,
  • "allowsDisconnectCustomer": true,
  • "allowsDisconnectService": true,
  • "allowsHotlineService": true,
  • "allowsReconnectCustomer": true,
  • "allowsReconnectService": true,
  • "allowsRedirectService": true,
  • "allowsRefreshService": true,
  • "allowsRestoreService": true,
  • "allowsReturnItem": true,
  • "allowsSuspendService": true,
  • "allowsSwapEquipment": true,
  • "allowsVoidTransaction": true,
  • "customerID": 1014,
  • "serviceID": 10101,
  • "startLocation": "AccountLevel"
}

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Release Notes

Release Notes 2.45

Release Notes 2.44

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.43

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.42

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.41

Release Notes 2.40

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.39

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.38

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.37

Release Notes 2.36

Release Notes 2.35

Release Notes 2.34

Release Notes 2.33

Release Notes 2.32

Release Notes 2.31

Release Notes 2.30

Release Notes 2.29

Release Notes 2.28

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.27

Release Notes 2.26

  • Added contractServiceAgreementID, documentTemplateTypeID, installmentAgreementGUID, installmentAgreementID as filterable fields for List Items With Agreements GET api/order/{orderID}/itemsWithAgreements

Release Notes 2.25

Release Notes 2.24

Release Notes 2.23

Release Notes 2.22

Release Notes 2.21

  • Added 'allowsBillPayment' to Allowed Starting Blocks POST api/startingBlock/allowedStartingBlocks
    • Added allowBillPayment to result set

Release Notes 2.20

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.19

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.18

Release Notes 2.17

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.16

Release Notes 2.15

Release Notes 2.14

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.13

Release Notes 2.12

Release Notes 2.11

Release Notes 2.10

Release Notes 2.09

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.08

  • Updated List Checkout Overview GET api/order/{orderID}/checkoutOverview
    • Added compactTaxMode and compactSubtotalMode to the query path parameters
    • Added itemCount and overviewPosition to the result set
  • Updated Search Order Details GET api/order/{orderID}/detail
    • Added serviceInformationItemID as sortable
    • Added serviceProcessingAction and serviceProcessingActionID to the result set

Release Notes 2.07

Release Notes 2.06

Release Notes 2.05

Release Notes 2.04

Release Notes 2.03

Release Notes 2.02

  • Added fields HandsetSupportedSIMClass, HandsetSupportedSIMClassID, SIMClass, and SIMClassID to Search Exchangeable Service Equipment GET api/customer/{customerID}/exchangeableServiceEquipment

Release Notes 2.01

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.00

  • Note: Major version change was for internal changes only and not a breaking change.

Release Notes 1.20

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.19

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.18

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.17

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.16

Release Notes 1.15

Release Notes 1.14

Release Notes 1.13

Release Notes 1.12

Release Notes 1.11

  • Updated Note for Locked, i.e. IsReadOnly on Capture Tender POST api/order/{orderID}/tender/{tenderInformationItemID}/capture

Release Notes 1.10

Release Notes 1.09

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.08

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.07

  • Added Capture Tender POST api/order/{orderID}/tender/{tenderInformationItemID}/capture

Release Notes 1.06

Release Notes 1.05

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.04

Release Notes 1.03

Release Notes 1.02

Release Notes 1.01

Release Notes 1.00

  • Initial Release